Gets a URL to download the file

Request

Gets a URL for downloading the file associated with the unique id. By default, the download URL is valid for 7 days.

Required roles: 'service.file.viewers'. Users added to groups 'users.datalake.viewers', 'users.datalake.editors', 'users.datalake.admins', 'users.datalake.ops' would be added to group 'service.file.viewers' by default.

Security

bearer

Path

Idstringrequired

File Metadata record Id.

Query

expiryTimestring

This parameter overrides the default time duration for which download URL is valid. If the value provided for this parameter is more than 7 days, the expiry time will be reset to 7 days only. Accepted Regex patterns are "^[0-9]+M$", "^[0-9]+H$", "^[0-9]+D$" denoting Integer values in Minutes, Hours, Days respectively.

Example:expiryTime=5M (i.e. 5 minutes) Or 2H (i.e. 2 hours) Or 1D (i.e. 1 day)

data-partition-idstringrequired

desired data partition id.

Example:slb-osdu-prod-des-prod-testing

curl -i -X GET \
  'https://as5.api.enterprisedata.slb.com/api/file/v2/files/{Id}/downloadURL?expiryTime=5M%20(i.e.%205%20minutes)%20Or%202H%20(i.e.%202%20hours)%20Or%201D%20(i.e.%201%20day)' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'data-partition-id: slb-osdu-prod-des-prod-testing'

Responses

A successful response

Bodyapplication/json

SignedURLstring

Response

{
  "SignedURL": "string"
}